/*-
 * #%L
 * Utility methods for BoneJ2
 * %%
 * Copyright (C) 2015 - 2023 Michael Doube, BoneJ developers
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package org.bonej.utilities;

import java.util.Collection;
import java.util.List;

import org.joml.Vector3dc;
import org.scijava.vecmath.Color3f;
import org.scijava.vecmath.Point3f;

import customnode.CustomPointMesh;
import ij3d.Image3DUniverse;

import static java.util.stream.Collectors.toList;

/**
 * Convenience methods for displaying data.
 * 
 * Helpful for debugging and for users to visualise their results.
 * 
 * @author Michael Doube
 *
 */
public class Visualiser {
	/**
	 * Plot a set of 3D coordinates in Benjamin Schmidt's ImageJ 3D Viewer
	 *
	 * @param vectors a collection of 3D (x,y,z) vectors
	 * @param title String name of the dataset
	 */
	public static void display3DPoints(final Collection<Vector3dc> vectors, final String title) {
		// Create a CustomMesh from the coordinates
		final List<Point3f> points = vectors.stream().map(Visualiser::toPoint).collect(toList());
		final CustomPointMesh cm = new CustomPointMesh(points);
		final Color3f green = new Color3f(0.0f, 0.5f, 0.0f);
		cm.setColor(green);
		cm.setPointSize(1);

		// Create a universe
		final Image3DUniverse univ = new Image3DUniverse();
		
		// Add the points
		univ.addCustomMesh(cm, title).setLocked(true);
		
		//show the universe
		univ.show();
	}

	private static Point3f toPoint(final Vector3dc v) {
		return new Point3f((float) v.x(), (float) v.y(), (float) v.z());
	}
}
